home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2002 #11 / Amiga Plus CD - 2002 - No. 11.iso / Online / GetAllHtml / GetAllHTML.doc < prev    next >
Text File  |  2002-10-28  |  15KB  |  315 lines
  1. GetAllHTML v1.00  Copyright 1998-2002 Christoper S Handley
  2. ==========================================================
  3. Latest News
  4. -----------
  5. This is (probably) my final release, as I have not updated the code in two
  6. years, and it seems to work very well for me.  Since it works well, I have
  7. finally given it v1.00 status!
  8.  
  9. Should now work on even more HTML pages due to minor improvements.
  10.  
  11.  
  12. If you cannot get ARexx to work, please read my warning below about text
  13. editors.
  14.  
  15. Introduction
  16. ------------
  17. Have you ever visited a cool web site & wanted to keep a copy of some/all of it,
  18. but it would takes ages to find & download all the respective pages/files?
  19.  
  20. This is the answer!
  21.  
  22. You supply this ARexx script with the start page URL, and a destination
  23. directory (which should be empty), and maybe a few other options - and off it
  24. goes!  Note that it needs HTTPResume v1.3+ to work (get from Aminet).
  25.  
  26. The idea for this came from a PC Java program called PageSucker - sadly it is
  27. over 1Mb in size & buggy (& can't be run on the Amiga, yet).  Although my
  28. implementation may not have quite as many features, it is does do the job quite
  29. fast, & has relatively low memory overheads.
  30.  
  31. Requirements
  32. ------------
  33.  o HTTPResume v1.3+ (but v1.7 is recommended)
  34.  
  35.  o An Amiga capable of running ARexx programs
  36.  
  37.  o Libs:Rexxsupport.library
  38.  
  39.  o Modem with TCP/IP stack (like Genesis, Miami, or AmiTCP)
  40.  
  41. Usage
  42. -----
  43. 1.Before running it for the first time you must (text) edit (say using C:ED) it
  44. to know where your copy of HTTPResume is located.  Go to line 19 where it says:
  45.     HTTPResume='Programs:Utils/Comms/HTTPResume'
  46. Alter the file path between the 'quotes' to where you keep HTTPResume, and save.
  47.  
  48. 2.Run your TCP/IP stack (e.g.AmiTCP/Genesis or Miami).
  49.  
  50. 3.Run it from a Shell using:
  51.  
  52.     Sys:RexxC/Rx GetAllHTML arguments
  53.  
  54. Where the arguments are:
  55.  
  56. "URL"/A, "DestDir"/A, NOASK/S, ARC/S, PIC/S, RESUME/S, PAUSE/S, DEPTH=/N/K,
  57. NOBASEINDEX, PORT=/K, BASEURL=/K, BROKELINKS/S
  58.  
  59. Note - The destination dir must be empty of any previous attempt at downloading
  60. that web page (unless using the RESUME switch).  And that both URL & DestDir
  61. *must* be enclosed in "double quotes" - and that the BASEURL must NOT be
  62. surrounded by quotes!
  63.  
  64. *Note* you may have several GetAllHTMLs & HTTPResumes running at the same time
  65. (not on the same URL!), and that if you use the PORT argument then you will need
  66. HTTPResume running first.
  67.  
  68. See the file GetAllHTML_ex.script for an example usage - it will download all of
  69. Squid's on-line artwork (hope he gets a few more sales of his wonderful 'other
  70. world' artwork from this :-).
  71.  
  72. Behaviour
  73. ---------
  74. It's default behaviour is to find all links in each HTML page, and download them
  75. if:
  76.  
  77. -the URL path is a sub-directory of the original URL path; this stops
  78. downloading irrelevant pages on different topics, different servers, etc.., AND
  79.  
  80. -if they are HTML pages (name ends in .html, etc), OR
  81.  
  82. -if not HTML pages then it will ask if the file should be downloaded; if answer
  83. does not begin with an "n" then it does (download).  If the file has the same
  84. suffix as the last positively confirmed download, then 'intelligently' assumes
  85. should download...
  86.  
  87. This behaviour is modified by various switches:
  88.  
  89. RESUME    - Should downloading of pages have been interupted (maybe a crash), run
  90.     GetAllHTML with *exactly* the same options, except with this switch too.
  91.     It will take a while to reach the same place as all previous HTML pages
  92.     must be scanned - and some additional memory usage is incured.
  93.  
  94.      I suggest you don't go on-line until it has reached the previously
  95.     interupted point (it wait for you to press return).
  96.  
  97.     *NOTE* that this mode is flawed due to the way GetAllHTML.rexx works,
  98.     so that it will sometimes think it has reached the previously finished
  99.     point, when it has not in fact.  Still RESUME is very useful!  And an
  100.     AmigaE version would fix this.
  101.  
  102. PIC    - Will identify links to pictures & download them rather than ask.
  103.  
  104. ARC    - Will identify links to archives & download them rather than ask.
  105.  
  106. NOASK    - Do not ask user if should download a file, assume should not.
  107.  
  108. PAUSE   - DO ask user to "press <return>" if we get an empty URL or couldn't
  109.     download a file.  Always asked to by the RESUME function.
  110.  
  111. TERSE    - Only outputs very important text, so it won't report strange URLs,
  112.     failure to download files, non-http links, etc...
  113.  
  114. PORT    - Supplies the ARexx port of a *running* HTTPResume; if supplied then
  115.     does not try to launch HTTPResume from AmigaDOS.  See *Note* below.  If
  116.     no port name is supplied then it sees if the current ARexx port is
  117.     already set to some HTTPResume - if not then an error is generated, else
  118.     it just uses that port.
  119.  
  120. DEPTH    - This allows you to specify how many URL links to follow in sequence;
  121.     i.e.the depth of the search.  DEPTH=2 means download only the links from
  122.     the original page, and so on for DEPTH=3, etc..  See *Note* below.  If
  123.     no number is supplied then the user is asked for a number.
  124.  
  125. NOBASEINDEX - This prevents GetAllHTML from following links to the index of the
  126.     original URL path.  Is useful for web sites which are fairly 'flat'
  127.     (ie.do not have many sub-directories), which also have banners at the
  128.     top of pages to take you straight to the site's main page (which will
  129.     has links you are not interested in).  Probably very rarely needed.
  130.  
  131. BASEURL - This allows you to override the semi-intelligent default, and tell
  132.     GetAllHTML the base URL - that is, what the URL must start with for it
  133.     to even consider downloading it.  This is useful if you wish to download
  134.     from a particular page deep down the directory structure, but which
  135.     references images (or maybe pages) that are further up.
  136.  
  137. BROKENLINKS - This causes attempted downloading of pages that are not
  138.     sub-directories of the original URL.  These will be downloaded to "T:"
  139.     (which is usually "RAM:T") & then deleted.  If download failed then you
  140.     will be told that there was a broken link.  See suggested uses below.
  141.  
  142. *Note* that both DEPTH & PORT must be followed by an equals sign ("=") and then
  143. the data, _without_ any spaces between anything.  This is due to a limitation of
  144. ARexx, for which an AmigaE version would fix.
  145.  
  146. SOLUTIONS TO FREQUENT PROBLEMS
  147. ------------------------------
  148. 1.If ARexx complains there is an error in the GetAllHTML code (when you try to
  149. run it), then it is VERY likely that the problem comes from editing GetAllHTML
  150. in a text editor.
  151.  
  152. Many text editors seem to be EXTREMELY badly coded, so that they can't handle
  153. the very long lines I have in GetAllHTML; they usually end up splitting a line
  154. in 2, or even deleting everything past a certain point on the line...
  155.  
  156. I strongly suggest buying CygnusEd (v3.5 or v4), as this is what I use, and I
  157. have never had any problems with it; it can even load in binary files, and save
  158. them back without loosing anything!
  159.  
  160. Suggested uses
  161. --------------
  162. 1.There's a big web site with lots of pictures/music/archives/information that
  163. interests you.  Depending on what you want, you will need to use the PIC, ARC,
  164. and NOASK switches.
  165.  
  166. For instance, if you are only interested in pictures then use PIC & NOASK.  If
  167. you are only interested in archives then use ARC & NOASK.  If you are interested
  168. in something else than pictures or archives (in addition to the web pages), then
  169. don't use any of those three switches - GetAllHTML will ask you if something
  170. should be downloaded.
  171.  
  172.  
  173. 2.You have your own home-page on the web, and it includes lots of links to other
  174. sites for which take hours to check they are all valid.  Point GetAllHTML at
  175. your web site with the BROKENLINKS switch.  Note it will never try to download a
  176. link twice, even withOUT using RESUME.
  177.  
  178. In fact, if you have your web site in a directory on your HD, then you could
  179. RESUME with that directory as your download directory; this will be MUCH faster
  180. since none of your pages will (or should) be downloaded :-)) .  First time you
  181. try this, do it on a back-up copy to ensure GetAllHTML does not do anything
  182. strange (I won't be held responsible for extra files 'magically' appearing!)..
  183.  
  184.  
  185. 3.I haven't tried this out myself, but it should be really cool:
  186.  
  187. If you have a favourite news page then you can use GetAllHTML to download just
  188. the latest news.  Suggest use NOASK, possibly with PIC if you want pictures too.
  189. You will obviously need to delete (or rename) the main news-page file, to force
  190. GetAllHTML to download the latest index which contains links to the new news.
  191.  
  192. I don't think you need to use RESUME, but...
  193.  
  194.  
  195. Any other ideas?
  196.  
  197. Bugs & other unwelcome features
  198. -------------------------------
  199.  o The RESUME feature *may* cause some files to be missed, but this depends on
  200. how ARexx treats funny characters for variable names.  An AmigaE version would
  201. fix any problems.
  202.  
  203.  o Interpretation of the HTML & URLs is based on observation rather than any
  204. specification of these standards - thus there will probably be rare cases in
  205. which it may misinterpret them; as long as these are reported (along with the
  206. responsible HTML file(s)), fixes will probably be forth coming.
  207.  
  208. But it really seems to work fine for the sites I have tried :-)
  209.  
  210.  o You cannot go above a depth of 42; this is to protect against an ARexx
  211. limitation which will cause problems above a depth of about 45.  An AmigaE
  212. version would fix this.
  213.  
  214. Technical info
  215. --------------
  216. GetAllHTML uses a depth-first tree search, via recursion, and uses the existance of
  217. (downloaded) files as a super-fast (for ARexx!) record of whether a page has
  218. been visited or not.
  219.  
  220. When RESUMEing, existance of files cannot be used to record if a page has been
  221. visited, so an alternate method is used - this is slower, and could fail with
  222. certain combinations of strangely named URLs (very unlikely); a far slower
  223. method would avoid this, but was considered unnecessary.
  224.  
  225. I used the INTERPRET command to do some magic with ARexx to make the arbitarily
  226. long linked-lists (really branches) possible - they were required for storing
  227. what pages have been visited.  Although this method is not very memory efficient
  228. (many duplicate entries of the same URL), it is quite fast - and more
  229. importantly it *works* in ARexx.  I had thought it would be virtually impossible
  230. to make arbitarily extended link-lists in ARexx, but the interpretive nature of
  231. ARexx means you can effectively create ARexx commands on-the-fly.
  232.  
  233. Future
  234. ------
  235. I have no plans for the future.  It has proven to work very well, and I have not
  236. updated it in 2 years.
  237.  
  238. About the Author
  239. ----------------
  240. My name is Christopher S Handley.  You're not really interested in me are you?!
  241.  
  242. Contacting the Author
  243. ---------------------
  244. Email: cshandley@iee.org
  245.  
  246. I am not yet sure about giving my snail mail address to all & sundry - sorry
  247. about that :-(I know how I felt when people did that before I had email access).
  248.  
  249. Thanks to
  250. ---------
  251.  o Andrija Antonijevic for HTTPResume
  252.  
  253.  o the Amiga community for sticking with the Amiga, and continuing to innovate.
  254.   Give your backing to KOSH (originally proposed by Fleecy Moss).
  255.  
  256.  o CU Amiga for becoming the greatest Amiga mag over the last year, before
  257.   passing away.  I did not like AF's Xmas issue at all (and AF didn't appear to
  258.   like my criticism of it either...)
  259.  
  260.  o whoever design the Rexx language - Rexx is great for 'user utilities'.
  261.  
  262. History
  263. -------
  264. v1.00  (22-08-02) - Should now handle URLs with "?" in them.  Now considers
  265.                     SWF (flash) files as pictures.  Final version?
  266.                     Added anti-spam stuff to email address :(
  267. v0.66ß (30-01-00) - Updated docs with new email address, warning about text
  268.             editors causing problems, and other small changes.
  269. v0.65ß (16-10-99) - Now searches from "HREF=" not "<A HREF=" which will give
  270.             dramatic improvement on some pages!  Rewrote how "./"s are
  271.             interpreted, which seems to be much better (perfect?).
  272.             Added the NOBASEINDEX switch.  Removed uses of Translate()
  273.             since it was doing nothing - so a small speed-up (esp.for
  274.             RESUME).
  275. v0.64ß (04-04-99) - Put back the 'extra' END that I removed in v0.61 .  Now
  276.             BROKENLINKS will always only try to download external links
  277.             once.  Removed NOENV argument of HTTPResume so proxy
  278.             settings may work.  Minor changes.
  279. v0.63ß (04-04-99) - Removed spurious non-visible ASCII (27) characters that
  280.            caused some text editors to go loopy.
  281. v0.62ß (03-04-99) - Add the BROKENLINKS switch.  Replaced NOPAUSE by PAUSE
  282.            switch.  Now always warns if a file could not be downloaded
  283.            (not just pages).  If you used all the arguments then it
  284.            would miss the last one.
  285. v0.61ß (28-03-99) - Possible fix for RESUME problem done, plus stupidly left an
  286.            extra END where it broke GetAllHTML.
  287. v0.60ß (27-03-99) - First stand-alone Aminet release.  Damn!  There were 3 big
  288.            mistakes...  (a)some files expected as directories,
  289.            (b)local-path expansion was too complex & probably wrong
  290.            (hope right now), (c)implicit InDeX.hTmL files were not
  291.            scanned for files.  Also asked user to press return but
  292.            really wanted a key first!
  293. v0.55ß (14-12-98) - Damn!  All this fast programming has introduced some bugs,
  294.            but they are fixed now; included the "~" interpretation was
  295.            completely wrong (removed), and fixed a long standing bug
  296.            where a URL beginning with a slash was mis-understood.  Also
  297.            added the BASEURL feature which is really useful sometimes.
  298. v0.54ß (12-12-98) - Given I couldn't download the KOSH pages (www.kosh.net), I
  299.            added basic frame support, and fixed a long standing bug
  300.                    where root html pages could appear as empty directories!
  301.            Two more long standing bugs fixed (ARC & PIC switches had
  302.            inverted sense).  Add fix for paths with "~" in, so will
  303.            align path correctly.  Add semi-intelligence so that won't
  304.            ask about downloading a file with the same suffix as the
  305.            last file that was confirmed.  Add the TERSE function.
  306. v0.53ß (10-12-98) - The DEPTH feature now works, added the PORT feature,
  307.            added the NOPAUSE feature.  Fixed long standing bug of NOASK
  308.            not being recognised.  Now removes text in URL after "?"s.
  309. v0.52ß ( 8-12-98) - Basically update documentation ready for it's first Aminet
  310.                    release, for when packaged along with HTTPResume.  Added an
  311.            untested DEPTH feature in the special v0.52aß.
  312. v0.51ß (??-??-98) - Internal speed-up (may be much faster downloading small pages)
  313.                   - minor fix of arguments given to HTTPResume
  314. v0.5ß  (??-??-98) - Initial release to a few people.  No bugs, honest =:)
  315.